<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Over The Air (OTA) Update Library: cy_ota_cb_struct_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="infineon_logo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Over The Air (OTA) Update Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Home</span></a></li>
      <li><a href="modules.html"><span>API&#160;Reference</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structcy__ota__cb__struct__t.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">cy_ota_cb_struct_t Struct Reference<div class="ingroups"><a class="el" href="group__group__ota__structures.html">OTA Structures</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>Structure passed to the callback. </p>
<p>This holds read/write data for the application to adjust various things in the callback. The callback is not in an interrupt context, but try to keep it quick! After your function returns, this structure is not available. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ae28ffd179023e8902cbd3e88785540ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ota__typedefs.html#gad852fa8cdb0431df709ccf12bb37cd60">cy_ota_cb_reason_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__cb__struct__t.html#ae28ffd179023e8902cbd3e88785540ad">reason</a></td></tr>
<tr class="memdesc:ae28ffd179023e8902cbd3e88785540ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reason for the callback.  <a href="#ae28ffd179023e8902cbd3e88785540ad">More...</a><br /></td></tr>
<tr class="separator:ae28ffd179023e8902cbd3e88785540ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa47e10a9fe4712558dded6625a3c484"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__cb__struct__t.html#afa47e10a9fe4712558dded6625a3c484">cb_arg</a></td></tr>
<tr class="memdesc:afa47e10a9fe4712558dded6625a3c484"><td class="mdescLeft">&#160;</td><td class="mdescRight">Argument passed when registering the callback.  <a href="#afa47e10a9fe4712558dded6625a3c484">More...</a><br /></td></tr>
<tr class="separator:afa47e10a9fe4712558dded6625a3c484"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdc59f29135abdca499c3da7183df1b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ota__typedefs.html#gab1539ebc23219f1ca64318286e9d375f">cy_ota_agent_state_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__cb__struct__t.html#afdc59f29135abdca499c3da7183df1b7">ota_agt_state</a></td></tr>
<tr class="memdesc:afdc59f29135abdca499c3da7183df1b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current OTA Agent state.  <a href="#afdc59f29135abdca499c3da7183df1b7">More...</a><br /></td></tr>
<tr class="separator:afdc59f29135abdca499c3da7183df1b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc8a4e04f407ca0bbf0dc35e7e42f0c1"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__cb__struct__t.html#acc8a4e04f407ca0bbf0dc35e7e42f0c1">error</a></td></tr>
<tr class="memdesc:acc8a4e04f407ca0bbf0dc35e7e42f0c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current OTA Agent error status.  <a href="#acc8a4e04f407ca0bbf0dc35e7e42f0c1">More...</a><br /></td></tr>
<tr class="separator:acc8a4e04f407ca0bbf0dc35e7e42f0c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafd5022e59a7d19d6a103f9217710644"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcy__ota__storage__write__info__t.html">cy_ota_storage_write_info_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__cb__struct__t.html#aafd5022e59a7d19d6a103f9217710644">storage</a></td></tr>
<tr class="memdesc:aafd5022e59a7d19d6a103f9217710644"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to a chunk of data to write.  <a href="#aafd5022e59a7d19d6a103f9217710644">More...</a><br /></td></tr>
<tr class="separator:aafd5022e59a7d19d6a103f9217710644"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad29859423d69a8e0815a833a70284bdb"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__cb__struct__t.html#ad29859423d69a8e0815a833a70284bdb">total_size</a></td></tr>
<tr class="memdesc:ad29859423d69a8e0815a833a70284bdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total # bytes to be downloaded.  <a href="#ad29859423d69a8e0815a833a70284bdb">More...</a><br /></td></tr>
<tr class="separator:ad29859423d69a8e0815a833a70284bdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab43108a89dadf59dcad71d4b4c75411d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__cb__struct__t.html#ab43108a89dadf59dcad71d4b4c75411d">bytes_written</a></td></tr>
<tr class="memdesc:ab43108a89dadf59dcad71d4b4c75411d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total # bytes downloaded.  <a href="#ab43108a89dadf59dcad71d4b4c75411d">More...</a><br /></td></tr>
<tr class="separator:ab43108a89dadf59dcad71d4b4c75411d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d802b856542ce6b7e59e2559026307d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__cb__struct__t.html#a1d802b856542ce6b7e59e2559026307d">percentage</a></td></tr>
<tr class="memdesc:a1d802b856542ce6b7e59e2559026307d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Percentage of bytes downloaded.  <a href="#a1d802b856542ce6b7e59e2559026307d">More...</a><br /></td></tr>
<tr class="separator:a1d802b856542ce6b7e59e2559026307d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabc069ca938caaeda44300df68d31903"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__ota__typedefs.html#gabc03646427dec963bef37cb5dbb550fa">cy_ota_connection_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__cb__struct__t.html#aabc069ca938caaeda44300df68d31903">connection_type</a></td></tr>
<tr class="memdesc:aabc069ca938caaeda44300df68d31903"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connection type <a class="el" href="group__group__ota__typedefs.html#gabc03646427dec963bef37cb5dbb550fa">cy_ota_connection_t</a>.  <a href="#aabc069ca938caaeda44300df68d31903">More...</a><br /></td></tr>
<tr class="separator:aabc069ca938caaeda44300df68d31903"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="ae28ffd179023e8902cbd3e88785540ad"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ota__typedefs.html#gad852fa8cdb0431df709ccf12bb37cd60">cy_ota_cb_reason_t</a> cy_ota_cb_struct_t::reason</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reason for the callback. </p>

</div>
</div>
<a class="anchor" id="afa47e10a9fe4712558dded6625a3c484"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* cy_ota_cb_struct_t::cb_arg</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Argument passed when registering the callback. </p>

</div>
</div>
<a class="anchor" id="afdc59f29135abdca499c3da7183df1b7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ota__typedefs.html#gab1539ebc23219f1ca64318286e9d375f">cy_ota_agent_state_t</a> cy_ota_cb_struct_t::ota_agt_state</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Current OTA Agent state. </p>

</div>
</div>
<a class="anchor" id="acc8a4e04f407ca0bbf0dc35e7e42f0c1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_ota_cb_struct_t::error</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Current OTA Agent error status. </p>

</div>
</div>
<a class="anchor" id="aafd5022e59a7d19d6a103f9217710644"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structcy__ota__storage__write__info__t.html">cy_ota_storage_write_info_t</a>* cy_ota_cb_struct_t::storage</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pointer to a chunk of data to write. </p>

</div>
</div>
<a class="anchor" id="ad29859423d69a8e0815a833a70284bdb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t cy_ota_cb_struct_t::total_size</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Total # bytes to be downloaded. </p>

</div>
</div>
<a class="anchor" id="ab43108a89dadf59dcad71d4b4c75411d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t cy_ota_cb_struct_t::bytes_written</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Total # bytes downloaded. </p>

</div>
</div>
<a class="anchor" id="a1d802b856542ce6b7e59e2559026307d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t cy_ota_cb_struct_t::percentage</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Percentage of bytes downloaded. </p>

</div>
</div>
<a class="anchor" id="aabc069ca938caaeda44300df68d31903"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__ota__typedefs.html#gabc03646427dec963bef37cb5dbb550fa">cy_ota_connection_t</a> cy_ota_cb_struct_t::connection_type</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Connection type <a class="el" href="group__group__ota__typedefs.html#gabc03646427dec963bef37cb5dbb550fa">cy_ota_connection_t</a>. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>Over The Air (OTA) Update Library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
</body>
</html>
